home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1993 July / Internet Tools.iso / RockRidge / mail / pine / imap-3.0 / ANSI / c-client / nntpclient.h < prev    next >
Encoding:
C/C++ Source or Header  |  1993-02-10  |  6.3 KB  |  138 lines
  1. /*
  2.  * Program:    Network News Transfer Protocol (NNTP) client routines
  3.  *
  4.  * Author:    Mark Crispin
  5.  *        Networks and Distributed Computing
  6.  *        Computing & Communications
  7.  *        University of Washington
  8.  *        Administration Building, AG-44
  9.  *        Seattle, WA  98195
  10.  *        Internet: MRC@CAC.Washington.EDU
  11.  *
  12.  * Date:    5 January 1993
  13.  * Last Edited:    11 February 1993
  14.  *
  15.  * Copyright 1993 by the University of Washington.
  16.  *
  17.  *  Permission to use, copy, modify, and distribute this software and its
  18.  * documentation for any purpose and without fee is hereby granted, provided
  19.  * that the above copyright notices appear in all copies and that both the
  20.  * above copyright notices and this permission notice appear in supporting
  21.  * documentation, and that the name of the University of Washington not be
  22.  * used in advertising or publicity pertaining to distribution of the software
  23.  * without specific, written prior permission.  This software is made
  24.  * available "as is", and
  25.  * THE UNIVERSITY OF WASHINGTON DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
  26.  * WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED
  27.  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN
  28.  * NO EVENT SHALL THE UNIVERSITY OF WASHINGTON BE LIABLE FOR ANY SPECIAL,
  29.  * INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
  30.  * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT
  31.  * (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN
  32.  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  33.  *
  34.  */
  35.  
  36. /* Constants */
  37.  
  38. #define NNTPGOK (long) 211    /* NNTP group selection OK */
  39. #define NNTPGLIST (long) 215    /* NNTP group list being returned */
  40. #define NNTPHEAD (long) 221    /* NNTP header text */
  41. #define NNTPBODY (long) 222    /* NNTP body text */
  42.  
  43.  
  44. /* Command bits from nntp_getflags() */
  45.  
  46. #define fSEEN 1
  47. #define fDELETED 2
  48. #define fFLAGGED 4
  49. #define fANSWERED 8
  50.  
  51.  
  52. /* NNTP I/O stream local data */
  53.     
  54. typedef struct nntp_local {
  55.   SMTPSTREAM *nntpstream;    /* NNTP stream for I/O */
  56.   unsigned int dirty : 1;    /* disk copy of .newsrc needs updating */
  57.   char *host;            /* local host name */
  58.   char *name;            /* local bboard name */
  59.   char *buf;            /* temporary buffer */
  60.   unsigned long buflen;        /* current size of temporary buffer */
  61.   unsigned long *number;    /* news message numbers */
  62.   char **header;        /* message headers */
  63.   char **body;            /* message bodies */
  64.   char *seen;            /* local seen status */
  65. } NNTPLOCAL;
  66.  
  67.  
  68. /* Convenient access to local data */
  69.  
  70. #define LOCAL ((NNTPLOCAL *) stream->local)
  71.  
  72. /* Function prototypes */
  73.  
  74. DRIVER *nntp_valid (char *name);
  75. void *nntp_parameters (long function,void *value);
  76. void nntp_find (MAILSTREAM *stream,char *pat);
  77. void nntp_find_bboards (MAILSTREAM *stream,char *pat);
  78. void nntp_find_all (MAILSTREAM *stream,char *pat);
  79. void nntp_find_all_bboards (MAILSTREAM *stream,char *pat);
  80. long nntp_subscribe (MAILSTREAM *stream,char *mailbox);
  81. long nntp_unsubscribe (MAILSTREAM *stream,char *mailbox);
  82. long nntp_subscribe_bboard (MAILSTREAM *stream,char *mailbox);
  83. long nntp_unsubscribe_bboard (MAILSTREAM *stream,char *mailbox);
  84. long nntp_create (MAILSTREAM *stream,char *mailbox);
  85. long nntp_delete (MAILSTREAM *stream,char *mailbox);
  86. long nntp_rename (MAILSTREAM *stream,char *old,char *new);
  87. MAILSTREAM *nntp_mopen (MAILSTREAM *stream);
  88. void nntp_close (MAILSTREAM *stream);
  89. void nntp_fetchfast (MAILSTREAM *stream,char *sequence);
  90. void nntp_fetchflags (MAILSTREAM *stream,char *sequence);
  91. ENVELOPE *nntp_fetchstructure (MAILSTREAM *stream,long msgno,BODY **body);
  92. char *nntp_fetchheader (MAILSTREAM *stream,long msgno);
  93. char *nntp_fetchtext (MAILSTREAM *stream,long msgno);
  94. char *nntp_fetchtext_work (MAILSTREAM *stream,long msgno);
  95. char *nntp_fetchbody (MAILSTREAM *stream,long m,char *s,unsigned long *len);
  96. char *nntp_slurp (MAILSTREAM *stream);
  97. void nntp_setflag (MAILSTREAM *stream,char *sequence,char *flag);
  98. void nntp_clearflag (MAILSTREAM *stream,char *sequence,char *flag);
  99. void nntp_search (MAILSTREAM *stream,char *criteria);
  100. long nntp_ping (MAILSTREAM *stream);
  101. void nntp_check (MAILSTREAM *stream);
  102. void nntp_expunge (MAILSTREAM *stream);
  103. long nntp_copy (MAILSTREAM *stream,char *sequence,char *mailbox);
  104. long nntp_move (MAILSTREAM *stream,char *sequence,char *mailbox);
  105. long nntp_append (MAILSTREAM *stream,char *mailbox,STRING *message);
  106. void nntp_gc (MAILSTREAM *stream,long gcflags);
  107.  
  108. short nntp_getflags (MAILSTREAM *stream,char *flag);
  109. char nntp_search_all (MAILSTREAM *stream,long msgno,char *d,long n);
  110. char nntp_search_answered (MAILSTREAM *stream,long msgno,char *d,long n);
  111. char nntp_search_deleted (MAILSTREAM *stream,long msgno,char *d,long n);
  112. char nntp_search_flagged (MAILSTREAM *stream,long msgno,char *d,long n);
  113. char nntp_search_keyword (MAILSTREAM *stream,long msgno,char *d,long n);
  114. char nntp_search_new (MAILSTREAM *stream,long msgno,char *d,long n);
  115. char nntp_search_old (MAILSTREAM *stream,long msgno,char *d,long n);
  116. char nntp_search_recent (MAILSTREAM *stream,long msgno,char *d,long n);
  117. char nntp_search_seen (MAILSTREAM *stream,long msgno,char *d,long n);
  118. char nntp_search_unanswered (MAILSTREAM *stream,long msgno,char *d,long n);
  119. char nntp_search_undeleted (MAILSTREAM *stream,long msgno,char *d,long n);
  120. char nntp_search_unflagged (MAILSTREAM *stream,long msgno,char *d,long n);
  121. char nntp_search_unkeyword (MAILSTREAM *stream,long msgno,char *d,long n);
  122. char nntp_search_unseen (MAILSTREAM *stream,long msgno,char *d,long n);
  123. char nntp_search_before (MAILSTREAM *stream,long msgno,char *d,long n);
  124. char nntp_search_on (MAILSTREAM *stream,long msgno,char *d,long n);
  125. char nntp_search_since (MAILSTREAM *stream,long msgno,char *d,long n);
  126. unsigned long nntp_msgdate (MAILSTREAM *stream,long msgno);
  127. char nntp_search_body (MAILSTREAM *stream,long msgno,char *d,long n);
  128. char nntp_search_subject (MAILSTREAM *stream,long msgno,char *d,long n);
  129. char nntp_search_text (MAILSTREAM *stream,long msgno,char *d,long n);
  130. char nntp_search_bcc (MAILSTREAM *stream,long msgno,char *d,long n);
  131. char nntp_search_cc (MAILSTREAM *stream,long msgno,char *d,long n);
  132. char nntp_search_from (MAILSTREAM *stream,long msgno,char *d,long n);
  133. char nntp_search_to (MAILSTREAM *stream,long msgno,char *d,long n);
  134. typedef char (*search_t) (MAILSTREAM *stream,long msgno,char *d,long n);
  135. search_t nntp_search_date (search_t f,long *n);
  136. search_t nntp_search_flag (search_t f,char **d);
  137. search_t nntp_search_string (search_t f,char **d,long *n);
  138.